Api.ReadAxisActualCurrent method

Reads the variable (#x6078) of actual current.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB
public KsReturn<short> ReadAxisActualCurrent(
       int Index
)
Public Function ReadAxisActualCurrent(
       Index As Integer
) As KsReturn(Of Short)

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Return value

Type: KsReturn<short>

Returns a KsError code and a short integer value.

Remarks

Used in the cyclic callback to check the actual current of an axis.

NOTE:  Actual current is available only if EnableActualCurrent is enabled.

Usable EtherCAT states

ecatOP

Examples

C#
N/A

See also

Api Class

IntervalZero.KINGSTAR.Local.Api Namespace